home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 126-150 / scopedisk127 / consolebuffer / cb.doc < prev    next >
Text File  |  1995-03-19  |  11KB  |  240 lines
  1.  
  2.                         Console Buffer by
  3.                         William J. Fritz
  4.                         4504 E. Yates Rd.
  5.                         Bensalem, Pa. 19020
  6.                         215-245-1584
  7.                         GEnie electronic mail address W.FRITZ1
  8.  
  9. PROGRAM UPDATES:
  10.  
  11. Version 1.1
  12.  
  13.     4/07/90    Due to a problem finding the font size if the font was changed
  14.                 after the console was opened I now use the font in the window
  15.                 rastport rather than the window font itself to find the ysize.
  16.  
  17.     5/11/90    Console hang problem using CB with the Matt Dillon Shell reported
  18.                 to me by Alan P. McDonley. I added code to filter Device Status
  19.                 Reports out of the buffer when it is displayed. These reports
  20.                 are sent to the console by the shell for every console prompt.
  21.  
  22.     5/11/90    Increased the maximum number of lines on a display from 50 to
  23.                 99 for those of you running an interlaced PAL screen with an
  24.                 eight or nine point font.
  25.  
  26.     5/12/90    Exiting from buffer display mode is now accomplished by hitting
  27.                 any unused key rather than the <q> key. Thanks to John Baker of
  28.                 Falls Church, Va. for the idea.
  29.  
  30.  
  31. CONDITIONS FOR USE AND DISTRIBUTION:
  32.  
  33.    CB is Copyright (c) 1990 by William J. Fritz
  34.  
  35.    CB is a copyrighted program that is provided "as is". There is no
  36. warranty, either expressed or implied, as to the quality or usefullness
  37. of the program. The user of the program accepts all risks associated with
  38. it's use.
  39.  
  40.    CB is freely distributable provided:
  41.  
  42.    1. The files are all left intact.
  43.    
  44.    2. No charge is made for CB (other than a reasonable copy charge of $6.00
  45.       or less)
  46.    
  47.    3. CB is not packaged as a part of a commercial product.
  48.  
  49.    4. CB may not be uploaded to any electronic service that claims
  50.       a copyright to it's files and programs.
  51.  
  52. DESCRIPTION:
  53.  
  54.    Console Buffer is for CLI users who would like to have a history
  55. and/or hardcopy (either file or device) of their console input and output.
  56. It works with both CLI and shell windows. Console I/O is saved in a
  57. buffer, the size of which is set by the user. The default buffer size is
  58. 100 lines.
  59.  
  60.    When the program is started a  proportional gadget is attached to the
  61. console window that can be used to scroll through the console I/O just as
  62. you would use a word processor vertical scroll gadget.
  63.  
  64.    The Console Buffer program consists of two modules.
  65.  
  66.    CB -              CB loads CB-handler if it is not loaded and
  67.                      interprets the command line arguments. If CB-handler
  68.                      is present the current status is reported.
  69.  
  70.    CB-handler -      CB-handler monitors the console that CB was started
  71.                      from, builds the buffer in memory and displays the
  72.                      buffer data. This module must be placed in either the
  73.                      current directory or the L: directory of the system
  74.                      disk in order for CB to find it.
  75.  
  76. CLI Argument Help:
  77.  
  78.    For command line argument help type <CB ?>.
  79.  
  80. START:
  81.  
  82.    To start CB type <CB> at the console you wish to monitor--this will
  83. use the default of 100 lines. Do not "run" the program. (e.g. "run CB"). If
  84. you wish another number of lines saved open with <CB -l###>, ### being the
  85. number of lines to save. For a hard-copy of the Console I/O start with
  86. <CB -hname>, the name being either a file name or device name. (e.g.<CB -hPRT:>
  87. to have the printer as the hardcopy device)
  88.    The -o, -q and -r options to output buffer, quit and reset cannot be used
  89. at Console Buffer startup as they pertain to a currently active buffer only.
  90.  
  91. DISPLAY:
  92.  
  93.    To display the buffer click on the proportional gadget in the right
  94. border of the console window. The title line of the console window will
  95. be changed to indicate display mode is active.
  96.  
  97.    While in display mode use either the prop gadget or the up and down
  98. arrow keys to view the buffer.
  99.  
  100.    up-arrow                scroll down one line
  101.    down-arrow              scroll up one line
  102.    shift-up-arrow          scroll down one window frame
  103.    shift-down-arrow        scroll up one window frame
  104.    control-up-arrow        scroll to top of buffer
  105.    control-down-arrow      scroll to bottom of buffer
  106.  
  107.    Single line scrolling is also possible by clicking and holding the mouse
  108. within the display window. The area that the mouse pointer occupies determines
  109. the speed and direction of scrolling. The window is divided into five horizontal
  110. zones of equal size. The center zone does no scrolling. The next zone out from
  111. the center gives a slow scroll. If the pointer above the center zone you will
  112. scroll down, if below you will scroll up. The top and bottom zones are for
  113. fast scrolling.
  114.  
  115.    Scrolling up or down by a window frame will be inaccurate if any lines
  116. within the displayed window frame contain more characters than can fit on
  117. a single  window line. When the cursor reaches the right edge of the window
  118. an automatic line feed is performed and the buffer line continues on the
  119. following window line. The problem is that this is still considered the
  120. same line to the program. Each time an automatic line feed is done the window
  121. frame scroll will go one line too far and the top line in the window frame
  122. will be scrolled off the display. If your buffer contains lines longer than
  123. the console window use the single line scroll instead of the window frame
  124. scroll.
  125.  
  126.    If another program sends something to the console window while in display
  127. mode it will be suspended until you return from display mode.
  128.  
  129.    To quit display mode and return to the normal console window enter any
  130. key other than the up and down arrow keys. The window's original title will
  131. re-appear.
  132.  
  133. COMMAND LINE OPTIONS:
  134.  
  135.    The command lines listed below facilitate:
  136.       1. Setting the maximum number of lines to keep in memory.
  137.       2. Specifying a hardcopy device or file for a permanent record of
  138.          console IO.
  139.       3. Setting the update frequency for the hardcopy device or file.
  140.       4. Including time stamps on console prompts in the buffer data.
  141.       5. Reseting the buffer - releasing the current data from memory.
  142.       6. Sending the currently buffered data to a device or file.
  143.       7. Exiting the Console Buffer program.
  144.  
  145.    The first time CB is called a buffer is started and whatever command
  146. line options are specified are activated. After the buffer is started you
  147. may alter any of these options by calling CB again with whatever changes
  148. you desire on the command line. Only the options on the command line will
  149. be changed.
  150.  
  151.    For example: if you are using a hardcopy and wish to delete it enter
  152. <CB -h>, the lack of a name after the <h> switch will cause no hardcopy to
  153. be used. Any remaining lines in the buffer that have not been copied to the
  154. hardcopy will be flushed.
  155.  
  156.    SET MAX LINES:  <CB -l200>
  157.  
  158.       The -l option sets the maximum number of lines to keep in memory. If the
  159.    number of lines is set after the program has been running and is lower than
  160.    that being currently buffered by the program, excess lines in the buffer
  161.    will be discarded.
  162.  
  163.       The above example would set the maximum number of lines that the buffer
  164.    will hold at 200. At the 201st line the first line that went into the buffer
  165.    would be discarded and the 201st line entered at the end.
  166.  
  167.       If you are using the hardcopy option the maximum number of lines that the
  168.    buffer will hold must be set higher than the hardcopy update value. If you
  169.    try to set it lower an error message will appear and the -l option will not
  170.    be done.
  171.  
  172.    HARDCOPY:   <CB -hPRT: -u25>
  173.  
  174.       The -h option (hardcopy) allows you to make a permanent record of the
  175.    console I/O. The buffer data can be directed to any AmigaDOS device or file.
  176.  
  177.       The format of the command line is <CB -hname> where name if the name of
  178.    the file or device that you wish to receive the hardcopy data. Note that
  179.    there must be no intervening spaces between the <h> and the <name>.
  180.  
  181.       The above example would send the hardcopy data to the printer, writing
  182.    to the printer only after 25 lines have been accumulated, then sending
  183.    all 25 lines.
  184.  
  185.       Care should be used with this option as using the printer for hardcopy
  186.    will significantly slow down the console I/O, specifying a floppy disk file
  187.    will require that disk be installed all the time the buffer is running.
  188.    Having a hardcopy does not preclude the use of the buffer.
  189.  
  190.       The -u option (update) specifies the frequency of hardcopy access. For
  191.    safety the hardcopy is opened and closed each time data is sent to it.
  192.    Doing this can perceptibly slow down the console. Using the update command
  193.    line option you can set the update value for writing to the hardcopy device
  194.    or file. This value specifies the number of lines to accumulate in the
  195.    buffer before sending them to the hardcopy. The update value, which
  196.    defaults to 10 lines, must be less than the maximum number of lines to
  197.    buffer.
  198.  
  199.    TIME STAMP:
  200.  
  201.       The -t option will mark all prompt lines in the buffer with the time that
  202.    the command is entered. The time is in military format. This time stamp will
  203.    only be in the buffer, not on the CLI display.
  204.    
  205.    RESET BUFFER:
  206.  
  207.       The -r option (reset buffer) releases all the lines currently being held
  208.    in memory. Using the -r option does not change the maximum number of lines
  209.    that the buffer can hold. This option is only valid on a running Console
  210.    Buffer, it can not be specified at start-up.
  211.    
  212.    OUTPUT BUFFER:
  213.  
  214.       The -o option (output buffer) dumps all of the lines currently being held
  215.    in memory to the specified file or device. The format is <CB -oname> where
  216.    name if the file or device you wish to receive the data. Note that there
  217.    must be no intervening spaces between the <o> and the <name>.
  218.       This option only pertains to a running Console Buffer and cannot be
  219.    specified on program start-up.
  220.  
  221.    QUIT:
  222.  
  223.       To quit and recover memory used by the buffer, type <CB -q>. If this
  224.    hangs do to an error in the conbuf-handler module you can exit with a
  225.    Control-C. Ending the CLI that the buffer is attached to will automatically
  226.    end that Console Buffer, recovering all memory used.
  227.  
  228. MEMORY REQUIREMENTS:
  229.  
  230.    After the program is started the storage used is approximately 9 K, plus
  231. the lines buffered. Each line buffered uses the size of the line plus eight
  232. bytes. Running the program with a 100 line buffer will use about 14K of
  233. storage. Using a 500 line buffer will require about 28K.
  234.  
  235. COMMENTS:
  236.  
  237.    Any comments, constructive criticism or useful additions to the program
  238. may be directed to me at the above address or on GEnie electronic mail at
  239. address W.FRITZ1
  240.